polish-css

PolishCSS :nail_care:

• Overview
• Quick start
• Installation
• Resources
• License

Overview

Spend less time reviewing pull requests. Make learning your rules simpler for new additions to the team. Keep your code more consistent and more reliable...

Or don't. You're the boss.

Play by your own rules with PolishCSS.

Features:

• :nail_care: Totally unopinionated. No default linters.
• :nail_care: Totally plugin based.
• :nail_care: Totally named in honor of the nail polish emoji.

PolishCSS works with CSS, SCSS, Sass, and Less.

Quick start

Do this:

var polish = require('polish-css');

Then do this:

var stylesheet       = '#css { color: red; }',
    pathToStylesheet = '/path/to/stylesheet',
    pluginsToUse     = ['polish-plugin-no-styling-ids'],
    errors;

errors = polish(stylesheet, pathToStylesheet, { plugins: pluginsToUse });

polish.reporter(pathToStylesheet, errors);

Linters can be ignored on a per-ruleset basis using inline commenting:

/* polish no-styling-ids=false */
#wont-be-reported {
  color: pink;
}

Installation

Install from npm: npm install polish-css

If you want to use the CLI, install PolishCSS globally: npm install -g polish-css

Resources

• Writing linters
• Using results
• Command line use

License

This project is licensed under the terms of the MIT license.